﻿/*
	Copyright (C) 2019 Zongming Liu <1849059316@qq.com>

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.
	
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.
	
	You should have received a copy of the GNU General Public License along
	with this program; if not, write to the Free Software Foundation, Inc.,
	51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#ifndef Action_h__
#define Action_h__

#include <string>
#include <memory>
#include "../utility/SmartPtrDef.h"
#include "../utility/NonCopyable.h"
#include "../utility/MacroTool.h"
#include "IActableObject.h"

namespace SkyEngine2d
{
	class Node;

	/*!
	 \brief 动作基类
	 \details 其他动作都是通过该类派生
	*/
	class SGE_API Action
		: public std::enable_shared_from_this<Action>, public NonCopyable
	{
	public:
		//! 析构
		virtual ~Action();

		//! 启动一个动画
		/*!
		\param const std::shared_ptr<IActableObject> & target 动画的执行目标
		\param bool isSuspend  是否挂起
		\return bool
		*/
		bool runWithTarget(IActableObject* target, bool isSuspend = false);

		//! 转换为 Action  指针
		/*!
		\return ActionSharedPtr
		*/
		ActionSharedPtr convertToActionSharedPtr();

		//! 动画是播放完毕
		/*!
		\return bool
		*/
		virtual bool isDone() const;

		//! 停止动画
		/*!
		\return void
		*/
		virtual void stop();

		//! 执行一步动画
		/*!
		\param float dt 时间增量 （秒）
		\return void
		*/
		virtual void step(float dt);

		//! 重置动画
		/*!
		\return void
		*/
		virtual void reverse();

		//! 获取动画的名字
		/*!
		\return const std::wstring&
		\sa void setName(const std::wstring& tag)
		*/
		const std::wstring& getName()const;

		//! 设置动画的名字
		/*!
		\param const std::wstring & tag
		\return void
		\sa const std::wstring& getName()const;
		*/
		void setName(const std::wstring& tag);

		//! 动画是否被挂起
		/*!
		\return bool
		*/
		bool isSuspend()const;

		//! 挂起动画
		/*!
		\return void
		*/
		void suspend();

		//! 恢复动画
		/*!
		\return void
		*/
		void  resume();

	protected:
		//! 构造
		Action();

		//! 设置动画的执行目标
		/*!
		\param const std::shared_ptr<IActableObject>& obj 目标
		\return bool  如果该目标无法执行动画，则返回 false
		*/
		virtual bool setActionTarget(IActableObject* obj) = 0;

		//! 更新动画
		/*!
		\param float ratio 动画当前的进度 值为 （0，1）
		\return void
		*/
		virtual void update(float ratio);

		//! 目标开始执行这个动画
		/*!
		\param const std::shared_ptr<IActableObject>& target
		\return bool  如果开始失败，则返回  false 可能是当前对象不支持执行该类型的动画
		*/
		virtual bool startWithTarget(IActableObject* target);

	protected:

		bool m_isDone; 	/*!< 是否停止. */

	private:

		std::wstring   m_name; 	//! 这个动画的名字
		bool  m_isSuspend;  //! 是否挂起
		friend class ActionManager;
	};

	////////////////////////与时间有关的动画的基类/////////////////////////////

	/*!
	 \brief 时间相关的动作的基类
	 \details
	*/
	class SGE_API ActionTime
		:public Action
	{
	public:
		//! 构造
		/*!
		\param float duration 这个动画需要执行的总时间
		*/
		ActionTime(float duration);

		ActionTimeSharedPtr convertToActionTimeSharedPtr();

		//! 析构
		virtual ~ActionTime();

		//! 获取当前动画的总执行时间
		/*!
		\return float
		*/
		float getDuration() { return m_duration; }

		//! 设置当前动画的总执行时间
		/*!
		\param float duration
		\return void
		*/
		void setDuration(float duration) { m_duration = duration; }

	protected:

		float m_duration; /*!< 这个动画需要的总的时间. */

	private:
		friend class ActionSequence;
	};
};



#endif // Action_h__
